home *** CD-ROM | disk | FTP | other *** search
/ Shareware Super Platinum 8 / Shareware Super Platinum 8.iso / mac / EDITORS / QUOTE300.ZIP;1 / QUOTE.DOC < prev    next >
Encoding:
Text File  |  1994-03-13  |  10.4 KB  |  277 lines
  1.  
  2.                              <<  Q U O T E  >>
  3.                         B Y   Æ F L A I R W A R E ! Ø
  4.                                Documentation
  5.                                  Ver. 3.00
  6.  
  7.  
  8.  OVERVIEW
  9.  --------
  10.  
  11.  QUOTE.EXE is an entertaining and educative quotation generator that brings
  12.  the thoughts of many of the world's greatest minds to your computer
  13.  monitor.
  14.  
  15.  Used in the simplest way, the program will bring up a random quotation
  16.  from a file of any length, and display it at the command line. A special
  17.  algorithm allows QUOTE.EXE to do this in the blink of any eye, no matter
  18.  how large your quotation file becomes, as you add *bons mots* of your own
  19.  to the large quotation file provided.
  20.  
  21.  This is particularly useful in your AUTOEXEC.BAT file, providing you a
  22.  thought-of-the-day on startup.
  23.  
  24.  But there's much more. You can specify the foreground and background
  25.  colours that QUOTE.EXE will use to print the quote, or instruct it to
  26.  print in the opposite intensity (highlight) of the current DOS colours;
  27.  
  28.  You can pop up a quotation in a window, returning to DOS with the screen
  29.  as it was when you entered the command (used in a batch file, this is a
  30.  good prelude to launching an application);
  31.  
  32.  QUOTE.EXE is also the ideal screen-saver, bringing up random quotations at
  33.  random screen locations, in random colour, with random width, to save your
  34.  monitor from ``burn-in'' when you're leaving your computer idle for a long
  35.  period of time; commands can be carried out in place of quotations, also
  36.  occurring randomly;
  37.  
  38.  You can even look up quotations on a theme: QUOTE.EXE will search for a
  39.  string you provide, showing all instances in a pop-up window.
  40.  
  41.  
  42.  INSTALLATION
  43.  ------------
  44.  
  45.  Installation of QUOTE.EXE is easy. Place a copy of QUOTE.EXE into a
  46.  directory specified in the PATH statement in your AUTOEXEC.BAT file,
  47.  along with the QUOTE.DAT file.
  48.  
  49.  QUOTE.EXE will pull quotations from the QUOTE.DAT file unless you specify
  50.  another quote file. To run QUOTE.EXE without specifying a quote file,
  51.  QUOTE.DAT must be in the current directory at the time the program is run.
  52.  
  53.  
  54.  BASIC COMMAND-LINE OPTIONS
  55.  --------------------------
  56.  
  57.  Basic command syntax:
  58.  
  59.  QUOTE {QuoteFileName} {ForeColour,BackColour} {/pop}"
  60.  {/hi} {"popquote search string"}
  61.  
  62.  Other options exist for the screen-saver function of QUOTE.EXE. These will
  63.  be covered below (see SCREEN-SAVER OPTIONS).
  64.  
  65.  - QuoteFileName: This is the path and name of the file containing your
  66.  formatted quotations. If you do not specify the path and name of the
  67.  quotation file, QUOTE.EXE will look for QUOTE.DAT in the current
  68.  directory; failing this, the program will end with an error message.
  69.  
  70.  The simplest operation is possible with QUOTE.DAT in the current
  71.  directory. Entering QUOTE will bring up a random quotation in the current
  72.  DOS screen colours.
  73.  
  74.  You may want to keep separate quotation files in different directories, for
  75.  different applications -- E.g. quotations about writing in your WP
  76.  directory, to pop up before or after you run the application from a batch
  77.  file.
  78.  
  79.  Examples:               QUOTE
  80.                          QUOTE QUOTE.DAT
  81.                          QUOTE C:\WP\PERSONAL.QUO
  82.  
  83.  - ForeColour, Backcolour: Specify the colours in which QUOTE.EXE will
  84.  display the random quotation. E.g. QUOTE c:\util\quote.dat 12,0 to print a
  85.  quotation with a bright red foreground and black background.
  86.  
  87.  Selectable colours are:
  88.  
  89.  Foreground or Background:                Foreground only:
  90.  
  91.  0 - black                                8 - gray
  92.  1 - blue                                 9 - bright blue
  93.  2 - green                               10 - bright green
  94.  3 - cyan                                11 - bright cyan
  95.  4 - red                                 12 - bright red
  96.  5 - magenta                             14 - bright magenta
  97.  6 - yellow                              15 - bright yellow
  98.  7 - white                               16 - bright white
  99.  
  100.  (Add 8 to above values for flashing foreground colour.)
  101.  
  102.  Examples:               QUOTE 13,0
  103.                          QUOTE C:\UTIL\QUOTE.DAT 3,0
  104.  
  105.  
  106.  - /POP brings up a random quotation in a box centred on your screen.
  107.  Default colours are bright white on blue, but you can specify foreground
  108.  and background colours, as above. Press a key and QUOTE.EXE restores your
  109.  screen as it was when you entered the command.
  110.  
  111.  After thirty seconds, the quotation will time out; this is useful for
  112.  inclusion in a batch file that runs an application such as Windows or
  113.  WordPerfect. If you start the application and then go for a coffee, for
  114.  example, the quotation won't prevent the initialization of your
  115.  application, while you're gone.
  116.  
  117.  Examples:               QUOTE /POP
  118.                          QUOTE C:\UTIL\QUOTE.DAT /POP
  119.                          QUOTE C:\UTIL\QUOTE.DAT 12,0 /POP
  120.                          QUOTE 12,0 /POP
  121.  
  122.  
  123.  - /HI brings up a random quotation using the inverse intensity (highlight)
  124.  of the current foreground colour.
  125.  
  126.  Examples:               QUOTE /HI
  127.                          QUOTE C:\UTIL\QUOTE.DAT /HI
  128.  
  129.  
  130.  - "popquote search string" will initiate a search for all quotations
  131.  containing the specified string, regardless of extra spaces and carriage
  132.  returns (at end of line).
  133.  
  134.  This is a good feature for browsing through the provided quotations, on
  135.  any theme you choose.
  136.  
  137.  Quotations will pop up sequentially, much as they do with the /POP option.
  138.  Because the file is read sequentially, this option runs a little more
  139.  slowly than the random quotation options, which use a special algorithm
  140.  that allows unlimited quotation files without loss of speed.
  141.  
  142.  Examples:               QUOTE "DOG"
  143.                          QUOTE "LOVE"
  144.                          QUOTE "WORK"
  145.  
  146.  Other options are disabled in search mode.
  147.  
  148.  
  149.  SCREEN-SAVER OPTIONS
  150.  --------------------
  151.  
  152.  Additional command options:
  153.  
  154.  QUOTE {QuoteFileName} {/FLOAT} {/SHORT} {/LONG} {/TIMEn} {/ADJUST}
  155.  
  156.  - /FLOAT: This parameter gives QUOTE.EXE one of its most useful features:
  157.  a screen-saver that brings up random quotations in random colour,
  158.  "floating" them at random locations with random line-width.
  159.  
  160.  This prevents ``burn-in'' on your monitor when your computer is idle for a
  161.  long time, and provides an interesting display while your computer is
  162.  idle. It even displays the current date and time.
  163.  
  164.  - /SHORT:   This parameter will display quotations for 6 seconds;
  165.  - /LONG:    Displays quotes for 15 seconds;
  166.  - /TIMEn:   Displays quotes for n seconds;
  167.  - /ADJUST:  Adds and additional 1.5 seconds per line, to allow reading of
  168.              longer quotes.
  169.  
  170.  Examples:               QUOTE /FLOAT
  171.                          QUOTE C:\UTIL\QUOTE.DAT /FLOAT
  172.                          QUOTE /FLOAT /SHORT
  173.                          QUOTE /FLOAT /SHORT /ADJUST
  174.                          QUOTE /FLOAT /TIME12
  175.                          QUOTE C:\UTIL\QUOTE.DAT /FLOAT /LONG /ADJUST
  176.  
  177.  QUOTATION FILE FORMAT
  178.  ---------------------
  179.  
  180.  The easiest way to add quotations to the provided QUOTE.DAT quote file, or
  181.  to create a separate one, is to follow the format in that file. Setting up
  182.  macros in your editor or word processor makes regular addition easy.
  183.  
  184.  Each quotation is preceded by the tilde character (~) on a single line
  185.  by itself. The quotation is indented a single space, followed by a blank
  186.  line. The attribution (name of person quoted) is on the next line,
  187.  preceded by a single hyphen.
  188.  
  189.  Without these elements, QUOTE.EXE may become confused, although it has a
  190.  certain amount of built-in intelligence to reformat quotations.
  191.  
  192.  Here is a portion of the quotation file, as an example:
  193.  
  194. ~
  195.  ``There are only two lasting bequests we can hope to give
  196.  our children. One of these is roots; the other, wings.''
  197.  
  198.                       - Hodding Carter
  199.  
  200. ~
  201.  ``Whatever you can do, or dream you can, begin it.
  202.  Boldness has genius, power and magic in it.''
  203.  
  204.                       - Goethe
  205.  
  206.  
  207.  Line length isn't essential, but the ideal is around 58.
  208.  
  209.  
  210.  
  211.  ADVANCED FEATURE
  212.  ----------------
  213.  
  214.  During screen-saver operation, you can access an additional feature to
  215.  give your display pizzazz.
  216.  
  217.  In the quotation file, on the line following the quote-delimiter (~),
  218.  simply enter a command instead of a quotation, preceded by the "%" symbol.
  219.  Example:
  220.  
  221. ~
  222.  %saytime
  223.  
  224.  This example will run the specified command, instead of bringing up a
  225.  quotation, if chosen at random. This is useful for product demonstrations
  226.  run from batch files, novelty displays, sound displays (E.g. digitized
  227.  samples or a time-speaking utility), or anything else you want to try.
  228.  
  229.  Include any command-line options required by the command. E.g.:
  230.  
  231. ~
  232.  %showgif c:\vga\mugshot.gif
  233.  
  234.  
  235.  
  236.  SHAREWARE
  237.  ---------
  238.  
  239.  QUOTE.EXE is a ShareWare program. You may use this software for a limited
  240.  time, to determine its usefulness to you. After that time, your are
  241.  required to register by paying a small fee of $9.
  242.  
  243.  Registered users will receive the latest version of QUOTE.EXE, without the
  244.  shareware notice that comes up an average of one time in ten, in place of
  245.  a quote.
  246.  
  247.  FlairWare! will also attempt to incorporate your own requested minor
  248.  modifications into your registered version. Two words are key -- we
  249.  will *attempt* to satisfy your requests for modifications, particularly
  250.  if they are *minor* ones. No guarantees, here! Minor modifications include
  251.  personalization, default changes, etc.
  252.  
  253.  If your suggestions are incorporated into a future general release of
  254.  QUOTE.EXE, FlairWare! will mail you the next major update, if any, of the
  255.  program, at no additional cost.
  256.  
  257.  To register, please send a cheque (check) or money order in Canadian or
  258.  U.S. funds, to:
  259.  
  260.                                 FlairWare!
  261.                                Stephen White
  262.                              206 Drewry Avenue
  263.                           Toronto, Ontario, Canada
  264.                                   M2M 1E4
  265.  
  266.  Please don't call unnecessarily, but if you have comments or concerns
  267.  about this software, you can reach me at (416) 733-0970. If you leave a
  268.  message, indicate whether I can call you back, collect; if so, remember
  269.  to leave your phone number.
  270.  
  271.  FlairWare! provides this software without any warranty as to its
  272.  suitability or capability of running without errors on your computer
  273.  system. Please use it at your own risk.
  274.  
  275.                       ===============================
  276.  
  277.